shared-domain-ux

(0 reviews)

TMF-720 - digitalIdentityValidation

==> TMF-720

This operation validates a digital Identity based on a token credential.

URL

https://[localhost]:[port]/shared-domain-ux/v1/{businessId}/digitalIdentityValidation

url Param

name	type	description	required
businessId	string	2 letter ISO 3166 country code (TT, BB, JM, PA, PR etc.) identifying the business unit. Expected one is "PR"-Puerto Rico	Y

name	value	description	required
client_id	string	The client_id identifying the channel.	Y
client_secret	string	Password associated with the client_id.	Y
X-Correlation-ID	string	Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.	Y

Request

curl --location 'https://nonprod.esb.cloud.lla.com/dev/shared-domain-ux/shared-domain-ux/v1/PR/digitalIdentityValidation' \
--header 'X-Correlation-Id: 644e1dd7-2a7f-18fb681143258' \
--header 'client_id: abcde' \
--header 'client_secret: 123456' \
--header 'Content-Type: application/json' \
--data-raw '{
  "credential": [
    {
      "id": "1",
      "login": "1234",
      "tokenCredential": "34567890876543",
      "@type": "TokenCredential"
    }
  ]
}'

Possible response success

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.

[ 200 ]

OK - The request was successfully processed and the digital identity validation result is returned.

{
    "credential": [
        {
            "id": "1",
            "state": "Active",   //Inactive when user is not verified
            "@type": "TokenCredential"
        }
    ]
}

Definitions

Each of the request parameters is detailed.

name	type	description	required
credential	array	List of credential objects used for user identity validation	Y
credential[].id	String	Unique identifier of the credential	Y
credential[].login	String	Login code or OTP used for verification	Y
credential[].tokenCredential	String	Encrypted token credential string for authentication	Y
credential[].@type	String	Type of the credential (e.g. TokenCredential)	Y